Platform Explorer / Nuxeo Platform 2023.21

Operation Services.SignPDF (Sign PDF)

In component org.nuxeo.ecm.platform.signature.core.operations.contrib

Description

Applies a digital signature to the input PDF.
Operation id Services.SignPDF
Category Services
Label Sign PDF
Requires
Since

Parameters

Name Description Type Required Default value
password Certificate password. string yes  
reason Signature reason. string yes  
username The user ID for signing PDF document. string yes  
document Document reference. document no  

Signature

Inputs blob
Outputs blob

Implementation Information

Implementation Class Class: org.nuxeo.ecm.platform.signature.core.operations.SignPDF
Contributing Component org.nuxeo.ecm.platform.signature.core.operations.contrib

JSON Definition

{
  "id" : "Services.SignPDF",
  "label" : "Sign PDF",
  "category" : "Services",
  "requires" : null,
  "description" : "Applies a digital signature to the input PDF.",
  "url" : "Services.SignPDF",
  "signature" : [ "blob", "blob" ],
  "params" : [ {
    "name" : "password",
    "description" : "Certificate password.",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "reason",
    "description" : "Signature reason.",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "username",
    "description" : "The user ID for signing PDF document.",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "document",
    "description" : "Document reference.",
    "type" : "document",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}